Step 3. Add Integration Tasks for Documents Generation
- From the main menu, click Integrations. The list of actions appears.
- At the top-right corner of the page, click the CreateConnectorAction button (
). The Edit Connector Action page appears.
- Provide the following details:
- Click Save. The page switches to the ConnectorSteps tab.
- At the top-right corner of the page, click the Create Task button (
). The drop-down lists all types of integrations tasks you can add.
- Scroll-down and choose the Document Generator task that suits your document template (Word or Excel).
- Provide the following details:
- Click Save.
- Publish the integration.
Parameter |
Description |
---|---|
Name |
The name of the action. The field is mandatory. |
Description |
A brief description of the action that might be useful for other tenant admins. The field is mandatory. |
Category |
Define on the spot when creating the action. Useful to easily find the actions in the Integrations list. The field is mandatory. |
Icon |
Select the icon that best describes the integration. It helps you easily identify the integration action in the list of integrations. If no icon is selected, DRUID will show default icon. Note: This field is available in DRUID 1.71 and higher.
|
Bot |
The name of the bot, which will be using the connector action. The field is mandatory. |
Request Entity Name |
The entity used by the chatbot to send data to the external app via the current action. |
Response Entity Name |
The entity used by the chatbot to receive data from the external app via the current action. |
Is Response Collection |
Tick only if the response is a list of records. E.g., a list of holidays, whereas each holiday has its own data set. |
Is Active |
Tick to activate the connector action. |
The task configuration page appears.
Field |
Description |
---|---|
Description |
Enter a brief description for the task. E.g., Invoice Generation. |
Connection Code |
Select Document_Generator. |
Document Template Name |
Select the template you uploaded to Documents. |
Use Dynamic Template Name |
Note: This option is available in DRUID v1.76 and higher.
Use dynamic template to specify the document template to be used from a DRUID entity field, instead of a fixed template, e.g., [[Employee]].TemplateName. If you tap on this option, the DocTemplateName will be replaced by the Dynamic Template Name field. For more information, see Generate Documents with Dynamic Templates. |
Dynamic File Name |
Note: This option is available in DRUID 5.14 and higher.
Specify the file name of the generated document either hard coded (e.g., "Invoice April") or as a value from the context: an entity field (e.g., [[Employee]].Name) or a local variable. If the field is empty, DRUID will use the template file name as file name of the generated document. |
Generated Extension |
The extension of the output document. If the task you selected is of type Word Document Generator, the following options are available: doc, docx, pdf. If the task you selected is of type Excel Document Generator, the following options are available: xls, xlsx, pdf. |
Password Protected |
Note: This setting is available in Druid version 1.57 o higher.
Tick on PasswordProtected to password protect a pdf output document. On the flow that generates the PDF document, before calling the DocumentGenerator connector, make sure to set the password value in field [[ChatUser]].PasswordForProtectedFiles in the Set Variables section. Important! If you're using [[ChatUser]] as request and response entity on the connector, the password will be saved in clear in the conversation history.
|
ProjectResultToEntityPath | Store the generated document in a specific entity field (a field of type file created on the request entity). |
Example: